chore: deprecate MkDocs docs#687
Draft
andreatgretel wants to merge 1 commit into
Draft
Conversation
Contributor
|
Fern preview: https://nvidia-preview-pr-687.docs.buildwithfern.com/nemo/datadesigner
|
64bf1d7 to
feafa25
Compare
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
feafa25 to
06dcf0f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Deprecates MkDocs as an active docs system on
mainnow that Fern is the canonical Data Designer docs surface.This PR does not modify the published
gh-pagesarchive. The archive freeze and GitHub Pages redirect behavior live in #688.Changes
mkdocs.yml, and MkDocs-only docs workflows frommain.uv.lock.docs/for Fern support inputs only: notebook sources, generated Colab notebooks, docs scripts, and downloadable recipe assets.https://docs.nvidia.com/nemo/datadesigner.fern/docs.yml.Archive Boundary
mainand stops new MkDocs builds from this branch.gh-pagesand freezes the GitHub Pages archive so only0.5.7and older remain available there.latest,0.6.0,0.5.9, and0.5.8GitHub Pages redirects to Fern.Attention Areas
docs/intentionally remains as a support directory for Fern-linked assets and notebooks..github/workflows/docs-preview.ymlnow posts Fern previews only.fern/docs.ymlremains the active Fern-side bridge for legacy MkDocs/devnotes paths.Testing
.venv/bin/ruff check --fix packages/data-designer/src/data_designer/interface/data_designer.py docs/notebook_source/*.py.venv/bin/ruff format packages/data-designer/src/data_designer/interface/data_designer.py docs/notebook_source/*.pymake generate-colab-notebooksmake check-fern-docs(fern check: 0 errors, 1 warning)git diff --check origin/main..HEADmake testpasses (not run locally; docs/CI cleanup only)